home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus Extra 1997 #2 / Amiga Plus Extra 1997 #2.iso / pd / misc / golded / api / readme < prev   
Encoding:
Text File  |  1997-02-16  |  2.1 KB  |  38 lines
  1.                            API - Application Interface
  2.  
  3. BASICS
  4.  
  5. GoldED offers two message-based application interfaces: ARexx and API.  The  API
  6. interface may be used by third party applications to register with GoldED: after
  7. having registered by sending the API command to GoldED's ARexx  port  they  will
  8. recieve  notify  messages from GoldED. Depending on these messages they can take
  9. approbiate actions (e.g. close their windows  if  GED  is  about  to  close  its
  10. screen,  indicating  this  by sending API_ACTION_HIDE messages to all registered
  11. clients). ARexx usually is used to control a program. The API interface is  used
  12. by GoldED to control the clients.
  13.  
  14. HOW TO RUN CLIENTS
  15.  
  16. Clients are launched as programs by GoldED during startup or after usage of  the
  17. API  requester.  The name of GoldED's port is passed as HOST=... argument to the
  18. client. The client is expected to  register  with  GoldED  by  sending  the  API
  19. command  to  this  port,  thus  requesting  notify classes (clients may select a
  20. subset of the available notifys) and providing GoldED with a message port for to
  21. send  notifies  to. The first command sent to the client's port after the client
  22. did register with GoldED will be  API_ACTION_INTRODUCE  (API_CLASS_ROOT  event).
  23. The  client is expected to return a short description of its abilities. The next
  24. command recieved by the client usally is API_ACTION_SHOW (in case the client did
  25. request  API_CLASS_SCREEN  events):  this  is GoldED's request to open a window.
  26. Notifes include a variety of  informations  about  the  editor's  current  state
  27. including  text  of  current  line,  window  dimensions and screen name. Several
  28. example API clients are shipped wiuth GoldED; please have a look at  the  source
  29. codec to understand the basic meachanisms.
  30.  
  31. RESTRICTIONS
  32.  
  33. After a client has registered with GoldED it has to be able  to  answer  notifys
  34. immediately  until  the  API_ACTION_DIE command is recieved. It may not exit. It
  35. may not Wait() for signals  unless  the  API  signals  are  included.  To  avoid
  36. deadlock problems, you may not wait for completion of ARexx requests sent to GED
  37. using WaitPort() (thus ignoring incoming API messages).
  38.